WordPress Playground Docs

Looking for the official Playground website?

WordPress Playground website moved to wordpress.org/playground/. The site you're at now hosts the documentation.

👋 Hi! Welcome to WordPress Playground documentation.

Playground is an online tool to experiment and learn about WordPress. This site (Documentation) is where you will find all the information you need to start using Playground.

The WordPress Playground documentation is distributed across four separate hubs (subsites):

• 👉 Documentation (you're here) – Introduction to WP Playground, starter guides and your entry point to WP Playground Docs.
• Blueprints – Blueprints are JSON files for setting up your WordPress Playground instance. Learn about their possibilities from the Blueprints docs hub.
• Developers – WordPress Playground was created as a programmable tool. Discover all the things you can do with it from your code in the Developers docs hub.
• API Reference – All the APIs exposed by WordPress Playground

Navigating this documentation hub

This docs hub is focused on starting with WordPress Playground and is divided into the following major sections.

• Quick Start Guide: For those just starting out with WordPress Playground, this is where you can get up and running with WordPress Playground quickly to start a new WordPress site and try a block/theme/plugin or test a specific WordPress/PHP version.

• Playground web instance: Learn more about the Playground instance you get at https://playground.wordpress.net/

• About Playground: To learn about WordPress Playground, how safe it is, what you can do with and some of its current limitations, visit this section.

  Discover how you can leverage WordPress Playground to Build, Test, and Launch your products.

• Guides: Explore our comprehensive guides to master new skills, find step-by-step instructions, and unlock valuable insights. Dive in to learn and grow!

• Contributing: WordPress Playground is an open-source project that welcomes all contributors—from code to design, documentation to triage. Learn here how to contribute.

• Links and resources: A nice compilation of useful links and resources related to WordPress Playground.

First steps

Whether you're a developer, a non-technical user, or a contributor, these docs will guide you as you start your learning journey:

• Start using WordPress Playground in 5 minutes (and check out the demo site)
• Get started for developing with WordPress Playground
• Use Playground as a zero-setup local development environment
• Read about the limitations
• WordCamp Contributor Day

tip

Read Introduction to Playground: running WordPress in the browser blog post in the WordPress Developer Blog for a great introduction to WordPress Playground

Take a deep dive

If you're a developer or tech user, you may want to check directly the APIs available:

• Read about Playground APIs and basic concepts
• Review links and resources
• Choose the right API for your app
  • Query API enable basic operations using only query parameters
  • Blueprints API give you a great degree of control with a simple JSON file
  • JavaScript API give you full control via a JavaScript client from an npm package
• Dive into the architecture and learn how it all works

Get Involved

WordPress Playground is an open-source project and welcomes all contributors from code to design, and from documentation to triage. Don't worry, you don't need to know WebAssembly to contribute!

• See the Contributors Handbook for all the details on how you can contribute.
• Join us in the #meta-playground channel in Slack (see the WordPress Slack page for signup information)

As with all WordPress projects, we want to ensure a welcoming environment for everyone. With that in mind, all contributors are expected to follow our Code of Conduct.

License

WordPress Playground is free software released under the terms of the GNU General Public License version 2 or (at your option) any later version. For a complete license, see LICENSE.md.